

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Overview: module code &mdash; NLP Architect by Intel® AI Lab 0.5.2 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../_static/jquery.js"></script>
        <script type="text/javascript" src="../_static/underscore.js"></script>
        <script type="text/javascript" src="../_static/doctools.js"></script>
        <script type="text/javascript" src="../_static/language_data.js"></script>
        <script type="text/javascript" src="../_static/install.js"></script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/nlp_arch_theme.css" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:100,900" type="text/css" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html">
          

          
            
            <img src="../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Jupyter Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../model_zoo.html">Model Zoo</a></li>
</ul>
<p class="caption"><span class="caption-text">NLP/NLU Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tagging/sequence_tagging.html">Sequence Tagging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../sentiment.html">Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../bist_parser.html">Dependency Parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intent.html">Intent Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lm.html">Language Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../information_extraction.html">Information Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../transformers.html">Transformers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../archived/additional.html">Additional Models</a></li>
</ul>
<p class="caption"><span class="caption-text">Optimized Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quantized_bert.html">Quantized BERT</a></li>
<li class="toctree-l1"><a class="reference internal" href="../transformers_distillation.html">Transformers Distillation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../sparse_gnmt.html">Sparse Neural Machine Translation</a></li>
</ul>
<p class="caption"><span class="caption-text">Solutions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../absa_solution.html">Aspect Based Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../term_set_expansion.html">Set Expansion</a></li>
<li class="toctree-l1"><a class="reference internal" href="../trend_analysis.html">Trend Analysis</a></li>
</ul>
<p class="caption"><span class="caption-text">For Developers</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../generated_api/nlp_architect_api_index.html">nlp_architect API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developer_guide.html">Developer Guide</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">NLP Architect by Intel® AI Lab</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
      <li>Overview: module code</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <h1>All modules for which code is available</h1>
<ul><li><a href="nlp_architect/api/abstract_api.html">nlp_architect.api.abstract_api</a></li>
<li><a href="nlp_architect/api/base.html">nlp_architect.api.base</a></li>
<li><a href="nlp_architect/api/bist_parser_api.html">nlp_architect.api.bist_parser_api</a></li>
<li><a href="nlp_architect/api/intent_extraction_api.html">nlp_architect.api.intent_extraction_api</a></li>
<li><a href="nlp_architect/api/ner_api.html">nlp_architect.api.ner_api</a></li>
<li><a href="nlp_architect/cli.html">nlp_architect.cli</a></li>
<ul><li><a href="nlp_architect/cli/cli_commands.html">nlp_architect.cli.cli_commands</a></li>
</ul><li><a href="nlp_architect/common/cdc/cluster.html">nlp_architect.common.cdc.cluster</a></li>
<li><a href="nlp_architect/common/cdc/mention_data.html">nlp_architect.common.cdc.mention_data</a></li>
<li><a href="nlp_architect/common/cdc/topics.html">nlp_architect.common.cdc.topics</a></li>
<li><a href="nlp_architect/common/config.html">nlp_architect.common.config</a></li>
<li><a href="nlp_architect/common/core_nlp_doc.html">nlp_architect.common.core_nlp_doc</a></li>
<li><a href="nlp_architect/common/high_level_doc.html">nlp_architect.common.high_level_doc</a></li>
<li><a href="nlp_architect/data/cdc_resources/data_types/wiki/wikipedia_page.html">nlp_architect.data.cdc_resources.data_types.wiki.wikipedia_page</a></li>
<li><a href="nlp_architect/data/cdc_resources/data_types/wiki/wikipedia_page_extracted_relations.html">nlp_architect.data.cdc_resources.data_types.wiki.wikipedia_page_extracted_relations</a></li>
<li><a href="nlp_architect/data/cdc_resources/data_types/wiki/wikipedia_pages.html">nlp_architect.data.cdc_resources.data_types.wiki.wikipedia_pages</a></li>
<li><a href="nlp_architect/data/cdc_resources/data_types/wn/wordnet_page.html">nlp_architect.data.cdc_resources.data_types.wn.wordnet_page</a></li>
<li><a href="nlp_architect/data/cdc_resources/embedding/embed_elmo.html">nlp_architect.data.cdc_resources.embedding.embed_elmo</a></li>
<li><a href="nlp_architect/data/cdc_resources/embedding/embed_glove.html">nlp_architect.data.cdc_resources.embedding.embed_glove</a></li>
<li><a href="nlp_architect/data/cdc_resources/gen_scripts/create_word_embed_elmo_dump.html">nlp_architect.data.cdc_resources.gen_scripts.create_word_embed_elmo_dump</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/computed_relation_extraction.html">nlp_architect.data.cdc_resources.relations.computed_relation_extraction</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/referent_dict_relation_extraction.html">nlp_architect.data.cdc_resources.relations.referent_dict_relation_extraction</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/relation_extraction.html">nlp_architect.data.cdc_resources.relations.relation_extraction</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/relation_types_enums.html">nlp_architect.data.cdc_resources.relations.relation_types_enums</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/verbocean_relation_extraction.html">nlp_architect.data.cdc_resources.relations.verbocean_relation_extraction</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/wikipedia_relation_extraction.html">nlp_architect.data.cdc_resources.relations.wikipedia_relation_extraction</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/within_doc_coref_extraction.html">nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/word_embedding_relation_extraction.html">nlp_architect.data.cdc_resources.relations.word_embedding_relation_extraction</a></li>
<li><a href="nlp_architect/data/cdc_resources/relations/wordnet_relation_extraction.html">nlp_architect.data.cdc_resources.relations.wordnet_relation_extraction</a></li>
<li><a href="nlp_architect/data/cdc_resources/wikipedia/wiki_elastic.html">nlp_architect.data.cdc_resources.wikipedia.wiki_elastic</a></li>
<li><a href="nlp_architect/data/cdc_resources/wikipedia/wiki_offline.html">nlp_architect.data.cdc_resources.wikipedia.wiki_offline</a></li>
<li><a href="nlp_architect/data/cdc_resources/wikipedia/wiki_online.html">nlp_architect.data.cdc_resources.wikipedia.wiki_online</a></li>
<li><a href="nlp_architect/data/cdc_resources/wikipedia/wiki_search_page_result.html">nlp_architect.data.cdc_resources.wikipedia.wiki_search_page_result</a></li>
<li><a href="nlp_architect/data/cdc_resources/wordnet/wordnet_offline.html">nlp_architect.data.cdc_resources.wordnet.wordnet_offline</a></li>
<li><a href="nlp_architect/data/cdc_resources/wordnet/wordnet_online.html">nlp_architect.data.cdc_resources.wordnet.wordnet_online</a></li>
<li><a href="nlp_architect/data/conll.html">nlp_architect.data.conll</a></li>
<li><a href="nlp_architect/data/fasttext_emb.html">nlp_architect.data.fasttext_emb</a></li>
<li><a href="nlp_architect/data/glue_tasks.html">nlp_architect.data.glue_tasks</a></li>
<li><a href="nlp_architect/data/intent_datasets.html">nlp_architect.data.intent_datasets</a></li>
<li><a href="nlp_architect/data/ptb.html">nlp_architect.data.ptb</a></li>
<li><a href="nlp_architect/data/sequence_classification.html">nlp_architect.data.sequence_classification</a></li>
<li><a href="nlp_architect/data/sequential_tagging.html">nlp_architect.data.sequential_tagging</a></li>
<li><a href="nlp_architect/data/utils.html">nlp_architect.data.utils</a></li>
<li><a href="nlp_architect/models.html">nlp_architect.models</a></li>
<ul><li><a href="nlp_architect/models/absa/inference/data_types.html">nlp_architect.models.absa.inference.data_types</a></li>
<li><a href="nlp_architect/models/absa/inference/inference.html">nlp_architect.models.absa.inference.inference</a></li>
<li><a href="nlp_architect/models/absa/train/acquire_terms.html">nlp_architect.models.absa.train.acquire_terms</a></li>
<li><a href="nlp_architect/models/absa/train/data_types.html">nlp_architect.models.absa.train.data_types</a></li>
<li><a href="nlp_architect/models/absa/train/generate_lexicons.html">nlp_architect.models.absa.train.generate_lexicons</a></li>
<li><a href="nlp_architect/models/absa/train/rerank_terms.html">nlp_architect.models.absa.train.rerank_terms</a></li>
<li><a href="nlp_architect/models/absa/train/rules.html">nlp_architect.models.absa.train.rules</a></li>
<li><a href="nlp_architect/models/absa/train/train.html">nlp_architect.models.absa.train.train</a></li>
<li><a href="nlp_architect/models/absa/utils.html">nlp_architect.models.absa.utils</a></li>
<li><a href="nlp_architect/models/bist/decoder.html">nlp_architect.models.bist.decoder</a></li>
<li><a href="nlp_architect/models/bist/eval/conllu/conll17_ud_eval.html">nlp_architect.models.bist.eval.conllu.conll17_ud_eval</a></li>
<li><a href="nlp_architect/models/bist/mstlstm.html">nlp_architect.models.bist.mstlstm</a></li>
<li><a href="nlp_architect/models/bist/utils.html">nlp_architect.models.bist.utils</a></li>
<li><a href="nlp_architect/models/bist_parser.html">nlp_architect.models.bist_parser</a></li>
<li><a href="nlp_architect/models/chunker.html">nlp_architect.models.chunker</a></li>
<li><a href="nlp_architect/models/cross_doc_coref/sieves_config.html">nlp_architect.models.cross_doc_coref.sieves_config</a></li>
<li><a href="nlp_architect/models/cross_doc_coref/sieves_resource.html">nlp_architect.models.cross_doc_coref.sieves_resource</a></li>
<li><a href="nlp_architect/models/cross_doc_coref/system/cdc_utils.html">nlp_architect.models.cross_doc_coref.system.cdc_utils</a></li>
<li><a href="nlp_architect/models/cross_doc_coref/system/sieves/run_sieve_system.html">nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system</a></li>
<li><a href="nlp_architect/models/cross_doc_coref/system/sieves/sieves.html">nlp_architect.models.cross_doc_coref.system.sieves.sieves</a></li>
<li><a href="nlp_architect/models/cross_doc_coref/system/sieves_container_init.html">nlp_architect.models.cross_doc_coref.system.sieves_container_init</a></li>
<li><a href="nlp_architect/models/cross_doc_sieves.html">nlp_architect.models.cross_doc_sieves</a></li>
<li><a href="nlp_architect/models/crossling_emb.html">nlp_architect.models.crossling_emb</a></li>
<li><a href="nlp_architect/models/intent_extraction.html">nlp_architect.models.intent_extraction</a></li>
<li><a href="nlp_architect/models/most_common_word_sense.html">nlp_architect.models.most_common_word_sense</a></li>
<li><a href="nlp_architect/models/ner_crf.html">nlp_architect.models.ner_crf</a></li>
<li><a href="nlp_architect/models/np2vec.html">nlp_architect.models.np2vec</a></li>
<li><a href="nlp_architect/models/np_semantic_segmentation.html">nlp_architect.models.np_semantic_segmentation</a></li>
<li><a href="nlp_architect/models/pretrained_models.html">nlp_architect.models.pretrained_models</a></li>
<li><a href="nlp_architect/models/tagging.html">nlp_architect.models.tagging</a></li>
<li><a href="nlp_architect/models/temporal_convolutional_network.html">nlp_architect.models.temporal_convolutional_network</a></li>
<li><a href="nlp_architect/models/transformers/base_model.html">nlp_architect.models.transformers.base_model</a></li>
<li><a href="nlp_architect/models/transformers/quantized_bert.html">nlp_architect.models.transformers.quantized_bert</a></li>
<li><a href="nlp_architect/models/transformers/sequence_classification.html">nlp_architect.models.transformers.sequence_classification</a></li>
<li><a href="nlp_architect/models/transformers/token_classification.html">nlp_architect.models.transformers.token_classification</a></li>
</ul><li><a href="nlp_architect/nn/tensorflow/python/keras/callbacks.html">nlp_architect.nn.tensorflow.python.keras.callbacks</a></li>
<li><a href="nlp_architect/nn/tensorflow/python/keras/layers/crf.html">nlp_architect.nn.tensorflow.python.keras.layers.crf</a></li>
<li><a href="nlp_architect/nn/tensorflow/python/keras/utils/layer_utils.html">nlp_architect.nn.tensorflow.python.keras.utils.layer_utils</a></li>
<li><a href="nlp_architect/nn/torch.html">nlp_architect.nn.torch</a></li>
<ul><li><a href="nlp_architect/nn/torch/data/dataset.html">nlp_architect.nn.torch.data.dataset</a></li>
<li><a href="nlp_architect/nn/torch/distillation.html">nlp_architect.nn.torch.distillation</a></li>
<li><a href="nlp_architect/nn/torch/layers/crf.html">nlp_architect.nn.torch.layers.crf</a></li>
<li><a href="nlp_architect/nn/torch/modules/embedders.html">nlp_architect.nn.torch.modules.embedders</a></li>
<li><a href="nlp_architect/nn/torch/quantization.html">nlp_architect.nn.torch.quantization</a></li>
</ul><li><a href="nlp_architect/pipelines/spacy_bist.html">nlp_architect.pipelines.spacy_bist</a></li>
<li><a href="nlp_architect/pipelines/spacy_np_annotator.html">nlp_architect.pipelines.spacy_np_annotator</a></li>
<li><a href="nlp_architect/procedures/procedure.html">nlp_architect.procedures.procedure</a></li>
<li><a href="nlp_architect/procedures/registry.html">nlp_architect.procedures.registry</a></li>
<li><a href="nlp_architect/procedures/token_tagging.html">nlp_architect.procedures.token_tagging</a></li>
<li><a href="nlp_architect/procedures/transformers/base.html">nlp_architect.procedures.transformers.base</a></li>
<li><a href="nlp_architect/procedures/transformers/glue.html">nlp_architect.procedures.transformers.glue</a></li>
<li><a href="nlp_architect/procedures/transformers/seq_tag.html">nlp_architect.procedures.transformers.seq_tag</a></li>
<li><a href="nlp_architect/utils/ansi2html.html">nlp_architect.utils.ansi2html</a></li>
<li><a href="nlp_architect/utils/embedding.html">nlp_architect.utils.embedding</a></li>
<li><a href="nlp_architect/utils/file_cache.html">nlp_architect.utils.file_cache</a></li>
<li><a href="nlp_architect/utils/generic.html">nlp_architect.utils.generic</a></li>
<li><a href="nlp_architect/utils/io.html">nlp_architect.utils.io</a></li>
<li><a href="nlp_architect/utils/metrics.html">nlp_architect.utils.metrics</a></li>
<li><a href="nlp_architect/utils/string_utils.html">nlp_architect.utils.string_utils</a></li>
<li><a href="nlp_architect/utils/testing.html">nlp_architect.utils.testing</a></li>
<li><a href="nlp_architect/utils/text.html">nlp_architect.utils.text</a></li>
<li><a href="pathlib.html">pathlib</a></li>
<li><a href="transformers/configuration_roberta.html">transformers.configuration_roberta</a></li>
</ul>

           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>